﻿//====================================================================================================================
//Copyright (c) 2011 IdeaBlade
//====================================================================================================================
//Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
//documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
//the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, 
//and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
//====================================================================================================================
//The above copyright notice and this permission notice shall be included in all copies or substantial portions of 
//the Software.
//====================================================================================================================
//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE 
//WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 
//OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
//OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
//====================================================================================================================

using System;
using IdeaBlade.Application.Framework.Core.Sync;
using IdeaBlade.Core.Composition;
using IdeaBlade.EntityModel;

namespace IdeaBlade.Application.Framework.Core.Persistence
{
    /// <summary>
    /// Controls the syncing of Entities between multiple EntityManagers.
    /// By default no entities are being synced.
    /// 
    /// To sync entities, create a subclass of EntityManagerSyncInterceptor
    /// and override the inherited methods to control the import and export
    /// of entities.
    /// </summary>
    [InterfaceExport(typeof(IEntityManagerSyncInterceptor))]
    public abstract class EntityManagerSyncInterceptor : IEntityManagerSyncInterceptor
    {
        /// <summary>Provides access to the importing or exporting EntityManager.</summary>
        /// <value>The instance of the EntityManager currently in the process of exporting or importing changed entities.</value>
        protected internal EntityManager EntityManager { get; internal set; }

        /// <summary>
        /// Controls which entities should be imported to the EntityManager
        /// </summary>
        /// <param name="entity"></param>
        /// <returns></returns>
        public virtual bool ShouldImportEntity(object entity)
        {
#pragma warning disable 612,618
            if (entity is IEntity) return ShouldImportEntity((IEntity) entity);
#pragma warning restore 612,618
            return false;
        }

        /// <summary>
        /// Controls which entities should be exported from an EntityManager
        /// </summary>
        /// <param name="entity"></param>
        /// <returns></returns>
        public virtual bool ShouldExportEntity(object entity)
        {
#pragma warning disable 612,618
            if (entity is IEntity) return ShouldExportEntity((IEntity) entity);
#pragma warning restore 612,618
            return false;
        }

        /// <summary>
        /// Obsolete.
        /// </summary>
        /// <param name="entity"></param>
        /// <returns></returns>
        [Obsolete("Use ShouldImportEntity(object) instead.")]
        public virtual bool ShouldImportEntity(IEntity entity)
        {
            return false;
        }

        /// <summary>
        /// Obsolete.
        /// </summary>
        /// <param name="entity"></param>
        /// <returns></returns>
        [Obsolete("Use ShouldExportEntity(object) instead.")]
        public virtual bool ShouldExportEntity(IEntity entity)
        {
            return false;
        }
    }
}